package com.ruoyi.common.core.domain;

import java.io.Serializable;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * Entity基类
 * <p>
 * 所有实体类的基类，提供通用字段如创建人、创建时间、更新人、更新时间等。
 * 同时支持搜索值和请求参数的传递。
 *
 * @author ruoyi
 */
public class BaseEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * 搜索值
     * <p>
     * 用于前端传入的模糊查询关键字，在序列化时忽略该字段。
     */
    @JsonIgnore
    private String searchValue;

    /**
     * 创建者
     * <p>
     * 记录数据创建人的标识信息。
     */
    private String createBy;

    /**
     * 创建时间
     * <p>
     * 数据创建的时间戳，格式为：yyyy-MM-dd HH:mm:ss。
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

    /**
     * 更新者
     * <p>
     * 记录最近一次修改数据人员的标识信息。
     */
    private String updateBy;

    /**
     * 更新时间
     * <p>
     * 最近一次更新记录的时间戳，格式为：yyyy-MM-dd HH:mm:ss。
     */
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;

    /**
     * 备注
     * <p>
     * 对当前记录的补充说明或备注信息。
     */
    private String remark;

    /**
     * 请求参数
     * <p>
     * 存储额外的请求参数，仅在非空时参与JSON序列化。
     */
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    private Map<String, Object> params;

    /**
     * 获取搜索值
     *
     * @return 搜索关键词字符串
     */
    public String getSearchValue() {
        return searchValue;
    }

    /**
     * 设置搜索值
     *
     * @param searchValue 搜索关键词
     */
    public void setSearchValue(String searchValue) {
        this.searchValue = searchValue;
    }

    /**
     * 获取创建者
     *
     * @return 创建者的用户标识
     */
    public String getCreateBy() {
        return createBy;
    }

    /**
     * 设置创建者
     *
     * @param createBy 创建者的用户标识
     */
    public void setCreateBy(String createBy) {
        this.createBy = createBy;
    }

    /**
     * 获取创建时间
     *
     * @return 创建时间的时间戳对象
     */
    public Date getCreateTime() {
        return createTime;
    }

    /**
     * 设置创建时间
     *
     * @param createTime 创建时间的时间戳对象
     */
    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    /**
     * 获取更新者
     *
     * @return 更新者的用户标识
     */
    public String getUpdateBy() {
        return updateBy;
    }

    /**
     * 设置更新者
     *
     * @param updateBy 更新者的用户标识
     */
    public void setUpdateBy(String updateBy) {
        this.updateBy = updateBy;
    }

    /**
     * 获取更新时间
     *
     * @return 更新时间的时间戳对象
     */
    public Date getUpdateTime() {
        return updateTime;
    }

    /**
     * 设置更新时间
     *
     * @param updateTime 更新时间的时间戳对象
     */
    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }

    /**
     * 获取备注信息
     *
     * @return 当前记录的备注内容
     */
    public String getRemark() {
        return remark;
    }

    /**
     * 设置备注信息
     *
     * @param remark 需要设置的备注内容
     */
    public void setRemark(String remark) {
        this.remark = remark;
    }

    /**
     * 获取请求参数映射表
     * <p>
     * 若未初始化则自动创建一个新的HashMap实例。
     *
     * @return 参数键值对集合
     */
    public Map<String, Object> getParams() {
        if (params == null) {
            params = new HashMap<>();
        }
        return params;
    }

    /**
     * 设置请求参数映射表
     *
     * @param params 参数键值对集合
     */
    public void setParams(Map<String, Object> params) {
        this.params = params;
    }
}
